home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / mcfgedv2.zip / MCFGEDIT.DOC next >
Text File  |  1992-01-19  |  11KB  |  305 lines
  1.  
  2.  
  3.      Message Area Editor 2.00 Documentation
  4.      Released January 20 1992
  5.      Author: Rick Cichon
  6.      Please Contact The Author By:
  7.     NetMail:Fido Net: 1:141/225
  8.         QBBSnet : 150:230/225
  9.      or through the QUICKBBS Echo.
  10.  
  11.      OverView
  12.      --------
  13.      MCFGEDIT.EXE allows you to compress your MSGCFG.DAT file. If you
  14.      have fragmented it by adding and deleting areas (deleting an area
  15.      leaves a empty area in it's place) this program will compress all
  16.      the areas to the beginning of the file. Example: Let's say you have
  17.      50 message areas spanning areas 1 to 100 with 50 blank areas in
  18.      between. MCFGEDIT will rewrite all those areas into areas 1 - 50.
  19.  
  20.      With the Registered version you also can rearrange the areas to your
  21.      specific needs. Example: You have QUICKPRO echo as area 3 and
  22.      QUICKBBS echo as area 23 you now have the ability to make them
  23.      areas 1 & 2 by only editing a text file.
  24.  
  25.      MCFGEDIT will also Recreate AREAS.BBS to the new format to insure
  26.      Echo Mail Integrity. Please see the WARNING section for details.
  27.  
  28.      Using the /L switch will create a master list of all your message
  29.      area numbers either before or after the program has been run.
  30.  
  31.  
  32.      Disclaimer
  33.      ----------
  34.  
  35.      PLEASE READ THE SECTION CALLED "WARNINGS" FOR SPECIAL INFORMATION!
  36.  
  37.      MCFGEDIT is free in it's unregistered form. If you would like to take
  38.      advantage of the registered features plesae send $10.00 (US) to:
  39.  
  40.      Rick Cichon
  41.      67 Dora Street
  42.      Stamford Ct  06902
  43.  
  44.      Much care and time has gone into testing this program to determine
  45.      that it does what this documentation states but you use this program
  46.      at your own risk. There is no guarantee either implied or expressed
  47.      provided with this program. I will however guarantee it will do
  48.      something.
  49.  
  50.      I will not be liable for any damages from the use of this program
  51.      and your use of this program constitutes agreement to this disclaimer
  52.      and releases the author from all liability or litigation.
  53.  
  54.      You are encouraged to copy and distribute this program as long as this
  55.      document in it's original form is included.
  56.  
  57.  
  58.      WARNINGS
  59.      --------
  60.  
  61.      MCFGEDIT will rearrange ALL of your message areas!
  62.      If you are not sure you will want to use the new format please backup
  63.      before you run the program. MCFGEDIT Writes to the following files:
  64.  
  65.      MSGCFG.DAT
  66.      MSGHDR.BBS
  67.      MSGIDX.BBS
  68.      MSGTOIDX.BBS
  69.      MSGINFO.BBS
  70.      All Menu Files  (Registered)
  71.      AREAS.BBS
  72.      COMBINED.BBS
  73.      LASTREAD.BBS
  74.  
  75.      The registerd version will Rewrite the menus files to the new format
  76.      while while using the Nonregistered version this will have to be done
  77.      manually. It will also write any obsolete menu commands to a text file
  78.      telling you what needs to be altered.
  79.  
  80.      What this means is if you are not registered and have a menu item with
  81.      a direct call to a read/write menu like this: RW /M=12 where Area 12
  82.      is the local SysOp Comments Area and you run this program then Area 12
  83.      could be ANYTHING. It is your responsibilty to change your Menu Entrys
  84.      to Match the new MSGCFG.DAT structure. If Area 12 was Deleted and there
  85.      was a menu command like {1} Joke Conference with a call of /M=12 then
  86.      this would now call what used to be area 13. A message would be sent to
  87.      the screen telling you and the information would be written BADMENU.TXT
  88.      in the directory you ran MCFGEDIT from.
  89.  
  90.      The following Menu Calls will be unaffected: /M=* ,/M- & /M+
  91.  
  92.      To insure that ECHO MAIL is not affected by this: If AREAS.BBS is in
  93.      the main QuickBBS directory (Which it SHOULD be if you have one) it
  94.      will be rewritten conforming to the new structure of MSGCFG.DAT.
  95.      The reason for this is two fold:
  96.  
  97.        1) It saves you a tremendous amount of work restructuring AREAS.BBS
  98.       and insures it is done accuratly.
  99.  
  100.        2) Most immportantly I do NOT want anyone blaming me for your
  101.       BAD_JOKES echo being tossed into the NUNS_ONLY Echo.
  102.  
  103.  
  104.      Also note: Copy the new MSGCFG.DAT to all node directories that use
  105.         their own DAT files for configuration.
  106.  
  107.      A note about offline mail programs. Unless the program gets the message
  108.      areas directly from MSGCFG.DAT these programs will need to be
  109.      reconfigured. I have no way of gaining access to these files and
  110.      could not support them even if I had wanted to.
  111.  
  112.      All versions will maintain the Last Read and Combined Pointers.
  113.  
  114.      Also PLEASE note: Runnung MSGPACK -i after running this program will
  115.      enable the display of message with (Deleted) after them. These will
  116.      not be in the correct area. Please run MSGPACK -P if you need to run
  117.      anything.
  118.  
  119.  
  120.  
  121.      Hardware & Software Requirements
  122.      --------------------------------
  123.  
  124.      IBM PC AT or Compatible
  125.      MS-DOS 3.0 and up. This was tested using DOS 3.3.
  126.      150k Free Ram
  127.      QuickBBS BBS Software, Version 2.75 and above.
  128.  
  129.  
  130.  
  131.      Features
  132.      --------
  133.  
  134.      * Creates MASTER listing of all Message Areas and their Area Numbers.
  135.  
  136.      * Compresses Areas in MSGCFG.DAT with all empty areas moved to the end.
  137.  
  138.  (r) * Creates a text file that can be edited to put Message Areas where
  139.        you want them.
  140.  
  141.  (r) * Rewrites all /M= lines in all menu files. Also fixes type 23,24,25
  142.        & 27 post new message lines.
  143.  
  144.      * Updates NETMAIL & Bad Password Boards in QUICKCFG.DAT
  145.  
  146.      * Retains users Combined & lastread pointers for all Message Areas
  147.  
  148.      * Recreates AREAS.BBS with new Message Area Formats to insure proper
  149.        echomail tossing.
  150.  
  151.  
  152.  
  153.      USING MCFGEDIT
  154.      --------------
  155.  
  156.      There is no configuration program for MCFGEDIT. It gets all of it's
  157.      information from QUICKCFG.DAT via DOS environment variable QUICK.
  158.  
  159.      Place MCFGEDIT.EXE & MCFGEDIT.KEY (Registered) in any directory and
  160.      run the program from there.
  161.  
  162.      There are 4 switches, one of which MUST be used, for use with this
  163.      program. The following is a brief comment about them and then a
  164.      detailed explanation of each.
  165.  
  166.      MCFGEDIT /L (LIST) (Can be run anytime)
  167.  
  168.      This will create a file called MSGCFG.LST which will be a listing
  169.      of the current format of the MSGCFG.DAT file. This can be read with
  170.      your favorite text editor.
  171.  
  172.      MCFGEDIT /C (COMPRESS)
  173.  
  174.      This will do a full compress of MSGCFG.DAT. This runs the /O & /I
  175.      functions togeather. This will take all blank message areas and
  176.      move them to the end of the file. Here's a handy tip, MCFGEDIT assumes
  177.      Message Area 200 to be blank, Fill in the fields the way you want all
  178.      blank fields to look and MCFGEDIT will use this a a template for all
  179.      of your unused Message Areas.
  180.  
  181.  (r) MCFGEDIT /O (OUT)  (Must Be Run First)
  182.  
  183.      This will take your current MSGCFG.DAT and write out files needed to
  184.      compress the file and allow you to edit the areas to your liking.
  185.      This is NON-destructive to your existing files! This run creates a
  186.      file called MSGCFG.IDX which you edit and put the Message Areas where
  187.      you want them. Nothing will be changed until you run MCFGEDIT /I. Also
  188.      note that area 200 will be used as a template for all blank areas so
  189.      if you edit it the way YOU want the default all blank areas will have
  190.      these attributes.
  191.  
  192.  
  193.  
  194.  (r) MCFGEDIT /I (IN)   (Must Be Run Second)
  195.  
  196.      This will do the rewriting of all neccessary files to rearrange your
  197.      message base to the new format you provided. It updates all pertinent
  198.      files to keep the attribute for all users. It will also rewrite any
  199.      menu recorde that use HardCoded area calls (EX: /M=10 ).
  200.  
  201.  
  202.      A TYPICAL RUN
  203.      -------------
  204.  
  205.      UNREGISTERED
  206.  
  207.      Run MCFGEDIT /C
  208.  
  209.      This will compress MSGCFG.DAT moving all blank areas to the end of the
  210.      file. There will be no more blank areas! I would suggest running
  211.      MCFGEDIT /L after this and use this as a Master Listing for updating
  212.      any hardcoded menu calls (EX: /M=10 ) in all *.MNU files. The
  213.      Combined & lastread pointers for all changed message areas will be
  214.      preserved along with a new Areas.bbs file being created.
  215.  
  216.      Copy MSGCFG.DAT to all node directories using a separate file.
  217.  
  218.  
  219.      REGISTERED
  220.  
  221.      Run MCFGEDIT /O
  222.  
  223.      This will create a file called MSGCFG.IDX which will look like an area
  224.      list when edited. You can MOVE the areas into any order you like. This
  225.      order will show up when a user access a verbose Message Area listing
  226.      along with forwarding and moving a message within QuickBBS. It was
  227.      the need to put my message areas in some semblenace of order that gave
  228.      birth to this program. DO NOT Add, Delete or Change any of the areas,
  229.      this is not within the scope of this program, this will cause an error
  230.      and put you right back where you started. No damage will be done just
  231.      a bit of wasted time.
  232.  
  233.      Run MCFGEDIT /I
  234.  
  235.      This will recreate MSGCFG.DAT using the order read from MSGCFG.IDX.
  236.      If AREAS.BBS is present ( IF you have one it should be!) it will also
  237.      rebuild it to the new structure. It will also write any ;COMMENTS it
  238.      finds to the top of the file and any P (Passthrough Areas) to the
  239.      end of AREAS.BBS. This AREAS.BBS file Will be fully functional....
  240.  
  241.      That's about it.. Please be reminded this is a very Powerful Program
  242.      and could end up opening a can of worms if not used properly..
  243.  
  244.  
  245.      REGISTRATION
  246.      -------------
  247.  
  248.      If you decide to continue using please send $10.00 to:
  249.  
  250.      Rick Cichon
  251.      67 Dora Street
  252.      Stamford, CT 06902
  253.  
  254.      Contact the author via QuickBBS Echo or:
  255.  
  256.      Fido Net 1:141/225 , QBBSnet 150:230/225 or
  257.      RJC Communications (203) 324-4495 At 14.4 HST Speeds
  258.  
  259.  
  260.  
  261.      USER SUPPORT
  262.      -------------
  263.  
  264.      Suggestions for enhancements are welcome.
  265.  
  266.  
  267.      Please send suggestions to Fido Net 1:141/225
  268.                 QBBSnet  150:230/225
  269.  
  270.  
  271.  
  272.      KUDOS
  273.      ------
  274.  
  275.      * Adam Hudson giving birth to QuickBBS.
  276.      * Pegasus Software: Steve Gabrilowitz & Richard Creighton for
  277.        "Legally" adopting and breathing life into QuickBBS.
  278.      * My Wife Leslie for beginning to understand what "It will
  279.        only take a few minutes" really means.
  280.      * Beta Testers:  Peter Kling
  281.               George Vandervort
  282.               Byron Hynes
  283.               Michael Twiselton
  284.               Mike Beecher
  285.  
  286.        Special thanks to the above (Brave) people who allowed me to
  287.        test live on their systems.
  288.  
  289.      PRODUCT INFORMATION
  290.      --------------------
  291.  
  292.      MSGPACK              (C) Pegasus Software
  293.      QuickBBS             (C) Pegasus Software
  294.      MS-DOS               MicroSoft Corporation
  295.      PKlite               PKWARE, Inc.
  296.      Turbo Pascal         (C) Borland International, Inc.
  297.  
  298.  
  299.      TECH NOTES
  300.      ----------
  301.  
  302.      Message Area Editor 1.00 was written in Turbo Pascal 6.0
  303.      Written & Tested using DOS 3.3 under Desqview 2.3 & QEMM 6.2
  304.      Mcfgedit.exe is compressed using PKLITE 1.13
  305.      Written & Tested On a 80486/33